Overhaul cleaners plugin; Add Maps::isPlantInBox #4949

Bumber64 · 2024-09-20T13:13:56Z

Overhaul cleaners to use cuboid selection instead of operating on entire map only. Can now remove grass (or just unused grass events for performance), skip cleaning blood/vomit/ooze when performing other cleanings, and counts arrow debris removal as affecting block.

Now uses argparse, which will affect existing command syntax. spotclean now just calls the existing map cleaning fn with a 1x1x1 cuboid. It could probably be replaced by an alias, assuming those work with hotkeys.

Removed clean plants option, as this was just rainwater (which evaporates and will be reapplied when it rains).

Moved a plant plugin utility fn out to Maps::isPlantInBox because it was going to be used for plant contaminant removal. This will detect if trees intersect with a box, so someone might have use for it.

Made burrows.cpp use Maps::forCoord instead of a nested x,y,z iterator.

Made tile-material.lua use maps.getPlantAtTile and handle tree root material properly.

* Cuboid selections * Lua argparse * Allow remove grass, skip blood removal * Better track affected blocks (arrow debris) * Debug logging

Bumber64 · 2024-09-20T13:24:22Z

plugins/cleaners.cpp

+command_result spotclean(color_ostream &out, vector<string> &parameters)
+{   // Hotkey command, already suspended
+    DEBUG(log, out).print("Doing spotclean.\n");
    if (!Maps::IsValid())
    {
        out.printerr("Map is not available.\n");
        return CR_FAILURE;
    }
-    df::map_block *block = Maps::getTileBlock(cursor->x, cursor->y, cursor->z);
-    if (block == NULL)
+    auto pos = Gui::getCursorPos();
+    if (!pos.isValid())
+    {
+        out.printerr("The keyboard cursor is not active.\n");
+        return CR_WRONG_USAGE;
+    }
+    auto block = Maps::getTileBlock(pos);
+    if (!block)
    {
        out.printerr("Invalid map block selected!\n");
        return CR_FAILURE;
    }
+    clean_options options;
+    options.mud = true;
+    options.snow = true;

-    for (auto evt : block->block_events)
-    {
-        if (evt->getType() != block_square_event_type::material_spatter)
-            continue;
-        // type verified - recast to subclass
-        df::block_square_event_material_spatterst *spatter = (df::block_square_event_material_spatterst *)evt;
-        clean_mud_safely(spatter, block->map_pos, df::coord(cursor->x % 16, cursor->y % 16, 0));
-    }
+    clean_block(out, block, cuboid(pos), options);
    return CR_OK;
 }


Could we make spotclean an alias for clean here -mds or possibly clean here -ads? (Should it include item spatter? A full command can be used if you want to avoid cleaning tree fruit.)

Bumber64 · 2024-09-20T13:26:24Z

Need to properly document syntax changes and clean plant removal.

* Update cleaners.rst * Update regrass.rst

* Update regrass.rst * Update cleaners.rst

for more information, see https://pre-commit.ci

myk002

More review to come, but let me submit the comments I have so I don't leave you hanging

myk002 · 2024-10-03T00:02:50Z

docs/changelog.txt

@@ -54,8 +54,10 @@ Template for new versions:
 ## New Tools

 ## New Features
+- `cleaners`: positional options to limit cleaning to a cuboid area. Options to remove grass or skip blood spatter removal.


Suggested change

- `cleaners`: positional options to limit cleaning to a cuboid area. Options to remove grass or skip blood spatter removal.

- `clean`: positional options to limit cleaning to a cuboid area. Options to remove grass or skip blood spatter removal.

there's an anchor alias that makes clean resolve to cleaners, and everyone knows this tool as "clean". We should really rename the plugin itself to "clean" at some point to reduce confusion..

myk002 · 2024-10-03T00:03:50Z

docs/changelog.txt


 ## Fixes
+- ``tile-material.lua``: made root tiles return tree material when not using GetLayerMat.


could you phrase this as a user-visible effect on a user-runnable tool?

I can't find any actual uses of it. There's one script buried in the Bay12 DFHack thread for regenerating ore veins. milochristiansen mentioned (in the last issue addressing it) that he used it in some old mods, but those aren't in any of his repos.

Users can just use probe.

I guess we should keep the script just in case someone needs it, but remove the entry from the changelog?

docs/changelog.txt

docs/dev/Lua API.rst

docs/plugins/cleaners.rst

* Pos args for isPlantInBox * Update changelog.txt * Update cleaners.rst

Bumber64 added 15 commits September 20, 2024 03:42

Update Lua API.rst - maps.isPlantInBox

79364de

Update cleaners.rst

8081985

Update regrass.rst - Talk about cleaners remove grass

174aa2e

Update LuaApi.cpp - Add maps.isPlantInBox

96ab31d

Update Maps.h - isPlantInBox

da108ee

Update tile-material.lua - Use getPlantAtTile; handle roots

b5dbea2

Update Maps.cpp - isPlantInBox

8f10e8e

Update CMakeLists.txt - cleaners link lua

ad11f48

Update burrow.cpp - Use Maps::forCoord; use using better

e3a529a

Update plant.cpp - Move utility fn to Maps module

d165e27

Update regrass.cpp - Maps::isValid is cleaner

86f98b0

Create cleaners.lua

4bd5bec

Update cleaners.cpp

a4ccb44

* Cuboid selections * Lua argparse * Allow remove grass, skip blood removal * Better track affected blocks (arrow debris) * Debug logging

Update cleaners.cpp - Remove plant cleaning (just rainwater)

9ac1ded

Update changelog.txt

f910c0c

Bumber64 commented Sep 20, 2024

View reviewed changes

Bumber64 added 9 commits September 20, 2024 06:27

Update changelog.txt

6375c92

Update cleaners.cpp - Fix print size_t

f89fc3c

Update cleaners.cpp - Really fix print size_t

961ceb8

Merge branch 'DFHack:develop' into cleaners_etc

3876041

Merge branch 'DFHack:develop' into cleaners_etc

317eaf3

Tidy up docs

244e848

* Update cleaners.rst * Update regrass.rst

More doc tidying

9b1b880

* Update regrass.rst * Update cleaners.rst

Update regrass.rst - Minor wording change

ed4e3e0

Update regrass.rst

6d26265

Bumber64 force-pushed the cleaners_etc branch 2 times, most recently from 0798023 to 6d26265 Compare December 8, 2024 08:38

Bumber64 and others added 2 commits December 8, 2024 01:01

Fix changelog.txt

e121d8f

Merge branch 'develop' into cleaners_etc

a2e1e68

Bumber64 and others added 4 commits December 10, 2024 21:42

Merge branch 'develop' into cleaners_etc

0c651d7

Fix changelog.txt

7b30129

[pre-commit.ci] auto fixes from pre-commit.com hooks

82ec22e

for more information, see https://pre-commit.ci

Merge branch 'develop' into cleaners_etc

82738b4

myk002 reviewed Dec 20, 2024

View reviewed changes

Bumber64 added 6 commits December 27, 2024 06:42

Update cleaners.cpp

28f7fca

Requested changes

7ecb7b7

* Pos args for isPlantInBox * Update changelog.txt * Update cleaners.rst

Merge branch 'develop' into cleaners_etc

79bdff8

Update cleaners.cpp

2519439

Update cleaners.cpp

9f73167

Merge branch 'develop' into cleaners_etc

16b311b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Overhaul cleaners plugin; Add Maps::isPlantInBox #4949

Overhaul cleaners plugin; Add Maps::isPlantInBox #4949

Bumber64 commented Sep 20, 2024 •

edited

Loading

Bumber64 Sep 20, 2024 •

edited

Loading

Bumber64 commented Sep 20, 2024

myk002 left a comment

myk002 Oct 3, 2024

myk002 Oct 3, 2024

myk002 Oct 3, 2024

Bumber64 Dec 20, 2024 •

edited

Loading

	- `cleaners`: positional options to limit cleaning to a cuboid area. Options to remove grass or skip blood spatter removal.
	- `clean`: positional options to limit cleaning to a cuboid area. Options to remove grass or skip blood spatter removal.


		## Fixes
		- ``tile-material.lua``: made root tiles return tree material when not using GetLayerMat.

Overhaul cleaners plugin; Add Maps::isPlantInBox #4949

Are you sure you want to change the base?

Overhaul cleaners plugin; Add Maps::isPlantInBox #4949

Conversation

Bumber64 commented Sep 20, 2024 • edited Loading

Bumber64 Sep 20, 2024 • edited Loading

Choose a reason for hiding this comment

Bumber64 commented Sep 20, 2024

myk002 left a comment

Choose a reason for hiding this comment

myk002 Oct 3, 2024

Choose a reason for hiding this comment

myk002 Oct 3, 2024

Choose a reason for hiding this comment

myk002 Oct 3, 2024

Choose a reason for hiding this comment

Bumber64 Dec 20, 2024 • edited Loading

Choose a reason for hiding this comment

Bumber64 commented Sep 20, 2024 •

edited

Loading

Bumber64 Sep 20, 2024 •

edited

Loading

Bumber64 Dec 20, 2024 •

edited

Loading